/*
* MIT License
*
* Copyright (c) 2017 wen.gu <454727014@qq.com>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/

/***************************************************************************
* Name: tiny_plugin.h
*
* Purpose: the base data structure of plugin
*
* Developer:
*   wen.gu , 2018-08-22
*
* TODO:
*
***************************************************************************/

#ifndef __TINY_PLUGIN_H__
#define __TINY_PLUGIN_H__

#include "general_type.h"
#include "tiny_component.h"

#ifdef __cplusplus
extern "C" {
#endif

/***************************************************************************
*
* macro declaration
*
***************************************************************************/
/** plugin header version
* note: plugin manager will check this version to jduagement current
*       plugin is compatible or not?
*/
#define TINY_PLUGIN_HEADER_VER "00.01.00"

/** the name of plugin entry, used by plugin manager */
#define TINY_PLUGIN_ENTRY_NAME "_tinyPluginEntry"
#define TINY_PLUGIN_VER_FUNC_NAME "baseOnPluginHeaderVersion"

/** the entry of plugin, used by plugin implementation */
#define TINY_PLUGIN_ENTRY() \
        const char* baseOnPluginHeaderVersion(){ \
            return TINY_PLUGIN_HEADER_VER; \
        } \
        tiny_plugin_t* _tinyPluginEntry()



/***************************************************************************
*
* data struct declaration
*
***************************************************************************/

typedef struct tiny_plugin_s
{
    GSTR name; /** the name of plugin */
    GSTR version; /** the version of plugin */
    GSTR author; /** the auothor of plugin */

    /** the member function to create a component insntance with "param" */
    GS32 (*createComponent)(struct tiny_plugin_s* tp,
                            tiny_component_t** comp,
                           const tiny_comp_create_param_t* param);

    void(*shutdown)(struct tiny_plugin_s* tp);
}tiny_plugin_t;



/** the type of plugin entry function, used by plugin manager */
typedef tiny_plugin_t* (*pluginEntryFunc_t)();
typedef const char* (*pluginHdrVerFunc_t)();


/***************************************************************************
*
* API declaration
*
***************************************************************************/

/** the plugin entry define */
G_API tiny_plugin_t* _tinyPluginEntry();

/** return the version of media plugin header */
G_API const char* baseOnPluginHeaderVersion();

#ifdef __cplusplus
}
#endif


#endif /** !__TINY_PLUGIN_H__*/